Carbon


GetControlRegion

Header: Controls.h Carbon status: Supported

Obtains the region corresponding to a given control part.

OSStatus GetControlRegion (
    ControlRef inControl, 
    ControlPartCode inPart, 
     outRegion
);
inControl

A handle to the control containing the part for which a region is to be obtained.

inPart

A constant identifying the control part for which a region is to obtained; you may specify the kControlStructureMetaPart and kControlContentMetaPart control part codes, as well as the standard control part codes. See “Meta Control Part Code Constants”, “Control Part Code Constants”, and “Control State Part Code Constants” for descriptions of possible values.

outRegion

On input, a value of type RgnHandle. On return, GetControlRegion sets the region to contain the actual dimensions and position of the control part, in local coordinates.

function result

A result code.

VERSION NOTES

This function is available with Mac OS 8.5 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.5 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)